home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 January: Mac OS SDK / Dev.CD Jan 98 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Universal / Interfaces / PInterfaces / Unicode.p < prev    next >
Encoding:
Text File  |  1997-08-12  |  10.9 KB  |  223 lines  |  [TEXT/MPS ]
  1. {
  2.      File:        Unicode.p
  3.  
  4.      Contains:    Types, constants, and prototypes for Unicode Converter
  5.  
  6.      Version:    Technology:    Mac OS 8 (Tempo)
  7.                  Release:    Universal Interfaces 3.0.1
  8.  
  9.      Copyright:    © 1994-1997 by Apple Computer, Inc., all rights reserved.
  10.  
  11.      Bugs?:        Please include the the file and version information (from above) with
  12.                  the problem description.  Developers belonging to one of the Apple
  13.                  developer programs can submit bug reports to:
  14.  
  15.                      devsupport@apple.com
  16.  
  17. }
  18. {$IFC UNDEFINED UsingIncludes}
  19. {$SETC UsingIncludes := 0}
  20. {$ENDC}
  21.  
  22. {$IFC NOT UsingIncludes}
  23.  UNIT Unicode;
  24.  INTERFACE
  25. {$ENDC}
  26.  
  27. {$IFC UNDEFINED __UNICODE__}
  28. {$SETC __UNICODE__ := 1}
  29.  
  30. {$I+}
  31. {$SETC UnicodeIncludes := UsingIncludes}
  32. {$SETC UsingIncludes := 1}
  33.  
  34. {$IFC UNDEFINED __TYPES__}
  35. {$I Types.p}
  36. {$ENDC}
  37. {$IFC UNDEFINED __TEXTCOMMON__}
  38. {$I TextCommon.p}
  39. {$ENDC}
  40. {$IFC UNDEFINED __MIXEDMODE__}
  41. {$I MixedMode.p}
  42. {$ENDC}
  43.  
  44.  
  45. {$PUSH}
  46. {$ALIGN MAC68K}
  47. {$LibExport+}
  48.  
  49. { Unicode conversion contexts: }
  50.  
  51. TYPE
  52.     TextToUnicodeInfo = ^LONGINT;
  53.     UnicodeToTextInfo = ^LONGINT;
  54.     UnicodeToTextRunInfo = ^LONGINT;
  55.     ConstTextToUnicodeInfo                = TextToUnicodeInfo;
  56.     ConstUnicodeToTextInfo                = UnicodeToTextInfo;
  57. { UnicodeMapVersion type & values }
  58.     UnicodeMapVersion                    = SInt32;
  59.  
  60. CONST
  61.     kUnicodeUseLatestMapping    = -1;
  62.  
  63. { Types used in conversion }
  64.  
  65. TYPE
  66.     UnicodeMappingPtr = ^UnicodeMapping;
  67.     UnicodeMapping = RECORD
  68.         unicodeEncoding:        TextEncoding;
  69.         otherEncoding:            TextEncoding;
  70.         mappingVersion:            UnicodeMapVersion;
  71.     END;
  72.  
  73.     ConstUnicodeMappingPtr                = ^UnicodeMapping;
  74. { Control flags for ConvertFromUnicodeToText and ConvertFromTextToUnicode }
  75.  
  76. CONST
  77.     kUnicodeUseFallbacksBit        = 0;
  78.     kUnicodeKeepInfoBit            = 1;
  79.     kUnicodeDirectionalityBits    = 2;
  80.     kUnicodeVerticalFormBit        = 4;
  81.     kUnicodeLooseMappingsBit    = 5;
  82.     kUnicodeStringUnterminatedBit = 6;
  83.     kUnicodeTextRunBit            = 7;
  84.     kUnicodeKeepSameEncodingBit    = 8;
  85.  
  86.     kUnicodeUseFallbacksMask    = $00000001;
  87.     kUnicodeKeepInfoMask        = $00000002;
  88.     kUnicodeDirectionalityMask    = $0000000C;
  89.     kUnicodeVerticalFormMask    = $00000010;
  90.     kUnicodeLooseMappingsMask    = $00000020;
  91.     kUnicodeStringUnterminatedMask = $00000040;
  92.     kUnicodeTextRunMask            = $00000080;
  93.     kUnicodeKeepSameEncodingMask = $00000100;
  94.  
  95. { Values for kUnicodeDirectionality field }
  96.     kUnicodeDefaultDirection    = 0;
  97.     kUnicodeLeftToRight            = 1;
  98.     kUnicodeRightToLeft            = 2;
  99.  
  100. { Directionality masks for control flags }
  101.     kUnicodeDefaultDirectionMask = $00;
  102.     kUnicodeLeftToRightMask        = $04;
  103.     kUnicodeRightToLeftMask        = $08;
  104.  
  105. { Control flags for TruncateForUnicodeToText: }
  106. {
  107.    Now TruncateForUnicodeToText uses control flags from the same set as used by
  108.    ConvertFromTextToUnicode, ConvertFromUnicodeToText, etc., but only
  109.    kUnicodeStringUnterminatedMask is meaningful for TruncateForUnicodeToText.
  110.    
  111.    Previously two special control flags were defined for TruncateForUnicodeToText:
  112.           kUnicodeTextElementSafeBit = 0
  113.           kUnicodeRestartSafeBit = 1
  114.    However, neither of these was implemented.
  115.    Instead of implementing kUnicodeTextElementSafeBit, we now use
  116.    kUnicodeStringUnterminatedMask since it accomplishes the same thing and avoids
  117.    having special flags just for TruncateForUnicodeToText
  118.    Also, kUnicodeRestartSafeBit is unnecessary, since restart-safeness is handled by
  119.    setting kUnicodeKeepInfoBit with ConvertFromUnicodeToText.
  120.    If TruncateForUnicodeToText is called with one or both of the old special control
  121.    flags set (bits 0 or 1), it will not generate a paramErr, but the old bits have no
  122.    effect on its operation.
  123. }
  124.  
  125. { Filter bits for filter field in QueryUnicodeMappings and CountUnicodeMappings: }
  126.     kUnicodeMatchUnicodeBaseBit    = 0;
  127.     kUnicodeMatchUnicodeVariantBit = 1;
  128.     kUnicodeMatchUnicodeFormatBit = 2;
  129.     kUnicodeMatchOtherBaseBit    = 3;
  130.     kUnicodeMatchOtherVariantBit = 4;
  131.     kUnicodeMatchOtherFormatBit    = 5;
  132.  
  133.     kUnicodeMatchUnicodeBaseMask = $00000001;
  134.     kUnicodeMatchUnicodeVariantMask = $00000002;
  135.     kUnicodeMatchUnicodeFormatMask = $00000004;
  136.     kUnicodeMatchOtherBaseMask    = $00000008;
  137.     kUnicodeMatchOtherVariantMask = $00000010;
  138.     kUnicodeMatchOtherFormatMask = $00000020;
  139.  
  140. { Control flags for SetFallbackUnicodeToText }
  141.     kUnicodeFallbackSequencingBits = 0;
  142.  
  143.     kUnicodeFallbackSequencingMask = $00000003;
  144.  
  145. { values for kUnicodeFallbackSequencing field }
  146.     kUnicodeFallbackDefaultOnly    = 0;
  147.     kUnicodeFallbackCustomOnly    = 1;
  148.     kUnicodeFallbackDefaultFirst = 2;
  149.     kUnicodeFallbackCustomFirst    = 3;
  150.  
  151.  
  152. { Caller-supplied entry point to a fallback handler }
  153.  
  154. TYPE
  155.     UnicodeToTextFallbackProcPtr = ProcPtr;  { FUNCTION UnicodeToTextFallback(VAR iSrcUniStr: UniChar; iSrcUniStrLen: ByteCount; VAR oSrcConvLen: ByteCount; oDestStr: TextPtr; iDestStrLen: ByteCount; VAR oDestConvLen: ByteCount; iInfoPtr: LogicalAddress; iUnicodeMappingPtr: ConstUnicodeMappingPtr): OSStatus; }
  156.  
  157.     UnicodeToTextFallbackUPP = UniversalProcPtr;
  158.  
  159. CONST
  160.     uppUnicodeToTextFallbackProcInfo = $003FFFF0;
  161.  
  162. FUNCTION NewUnicodeToTextFallbackProc(userRoutine: UnicodeToTextFallbackProcPtr): UnicodeToTextFallbackUPP;
  163.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  164.     INLINE $2E9F;
  165.     {$ENDC}
  166.  
  167. FUNCTION CallUnicodeToTextFallbackProc(VAR iSrcUniStr: UniChar; iSrcUniStrLen: ByteCount; VAR oSrcConvLen: ByteCount; oDestStr: TextPtr; iDestStrLen: ByteCount; VAR oDestConvLen: ByteCount; iInfoPtr: LogicalAddress; iUnicodeMappingPtr: ConstUnicodeMappingPtr; userRoutine: UnicodeToTextFallbackUPP): OSStatus;
  168.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  169.     INLINE $205F, $4E90;
  170.     {$ENDC}
  171. { Function prototypes }
  172. {$IFC GENERATING68K }
  173. { Rounite to Initialize the Unicode Converter and cleanup once done with it }
  174. FUNCTION InitializeUnicode(TECFileName: StringPtr): OSStatus;
  175. PROCEDURE TerminateUnicode;
  176. {$ENDC}  {GENERATING68K}
  177.  
  178. FUNCTION CreateTextToUnicodeInfo(iUnicodeMapping: ConstUnicodeMappingPtr; VAR oTextToUnicodeInfo: TextToUnicodeInfo): OSStatus;
  179. FUNCTION CreateTextToUnicodeInfoByEncoding(iEncoding: TextEncoding; VAR oTextToUnicodeInfo: TextToUnicodeInfo): OSStatus;
  180. FUNCTION CreateUnicodeToTextInfo(iUnicodeMapping: ConstUnicodeMappingPtr; VAR oUnicodeToTextInfo: UnicodeToTextInfo): OSStatus;
  181. FUNCTION CreateUnicodeToTextInfoByEncoding(iEncoding: TextEncoding; VAR oUnicodeToTextInfo: UnicodeToTextInfo): OSStatus;
  182. FUNCTION CreateUnicodeToTextRunInfo(iNumberOfMappings: ItemCount; {CONST}VAR iUnicodeMappings: UnicodeMapping; VAR oUnicodeToTextInfo: UnicodeToTextRunInfo): OSStatus;
  183. FUNCTION CreateUnicodeToTextRunInfoByEncoding(iNumberOfEncodings: ItemCount; {CONST}VAR iEncodings: TextEncoding; VAR oUnicodeToTextInfo: UnicodeToTextRunInfo): OSStatus;
  184. FUNCTION CreateUnicodeToTextRunInfoByScriptCode(iNumberOfScriptCodes: ItemCount; {CONST}VAR iScripts: ScriptCode; VAR oUnicodeToTextInfo: UnicodeToTextRunInfo): OSStatus;
  185. { Change the TextToUnicodeInfo to another mapping. }
  186. FUNCTION ChangeTextToUnicodeInfo(ioTextToUnicodeInfo: TextToUnicodeInfo; iUnicodeMapping: ConstUnicodeMappingPtr): OSStatus;
  187. { Change the UnicodeToTextInfo to another mapping. }
  188. FUNCTION ChangeUnicodeToTextInfo(ioUnicodeToTextInfo: UnicodeToTextInfo; iUnicodeMapping: ConstUnicodeMappingPtr): OSStatus;
  189. FUNCTION DisposeTextToUnicodeInfo(VAR ioTextToUnicodeInfo: TextToUnicodeInfo): OSStatus;
  190. FUNCTION DisposeUnicodeToTextInfo(VAR ioUnicodeToTextInfo: UnicodeToTextInfo): OSStatus;
  191. FUNCTION DisposeUnicodeToTextRunInfo(VAR ioUnicodeToTextRunInfo: UnicodeToTextRunInfo): OSStatus;
  192. FUNCTION ConvertFromTextToUnicode(iTextToUnicodeInfo: TextToUnicodeInfo; iSourceLen: ByteCount; iSourceStr: ConstLogicalAddress; iControlFlags: OptionBits; iOffsetCount: ItemCount; VAR iOffsetArray: ByteOffset; VAR oOffsetCount: ItemCount; VAR oOffsetArray: ByteOffset; iOutputBufLen: ByteCount; VAR oSourceRead: ByteCount; VAR oUnicodeLen: ByteCount; oUnicodeStr: UniCharArrayPtr): OSStatus;
  193. FUNCTION ConvertFromUnicodeToText(iUnicodeToTextInfo: UnicodeToTextInfo; iUnicodeLen: ByteCount; iUnicodeStr: ConstUniCharArrayPtr; iControlFlags: OptionBits; iOffsetCount: ItemCount; VAR iOffsetArray: ByteOffset; VAR oOffsetCount: ItemCount; VAR oOffsetArray: ByteOffset; iOutputBufLen: ByteCount; VAR oInputRead: ByteCount; VAR oOutputLen: ByteCount; oOutputStr: LogicalAddress): OSStatus;
  194. FUNCTION ConvertFromUnicodeToTextRun(iUnicodeToTextInfo: UnicodeToTextRunInfo; iUnicodeLen: ByteCount; iUnicodeStr: ConstUniCharArrayPtr; iControlFlags: OptionBits; iOffsetCount: ItemCount; VAR iOffsetArray: ByteOffset; VAR oOffsetCount: ItemCount; VAR oOffsetArray: ByteOffset; iOutputBufLen: ByteCount; VAR oInputRead: ByteCount; VAR oOutputLen: ByteCount; oOutputStr: LogicalAddress; iEncodingRunBufLen: ItemCount; VAR oEncodingRunOutLen: ItemCount; VAR oEncodingRuns: TextEncodingRun): OSStatus;
  195. FUNCTION ConvertFromUnicodeToScriptCodeRun(iUnicodeToTextInfo: UnicodeToTextRunInfo; iUnicodeLen: ByteCount; iUnicodeStr: ConstUniCharArrayPtr; iControlFlags: OptionBits; iOffsetCount: ItemCount; VAR iOffsetArray: ByteOffset; VAR oOffsetCount: ItemCount; VAR oOffsetArray: ByteOffset; iOutputBufLen: ByteCount; VAR oInputRead: ByteCount; VAR oOutputLen: ByteCount; oOutputStr: LogicalAddress; iScriptRunBufLen: ItemCount; VAR oScriptRunOutLen: ItemCount; VAR oScriptCodeRuns: ScriptCodeRun): OSStatus;
  196. { Truncate a multibyte string at a safe place. }
  197. FUNCTION TruncateForTextToUnicode(iTextToUnicodeInfo: ConstTextToUnicodeInfo; iSourceLen: ByteCount; iSourceStr: ConstLogicalAddress; iMaxLen: ByteCount; VAR oTruncatedLen: ByteCount): OSStatus;
  198. { Truncate a Unicode string at a safe place. }
  199. FUNCTION TruncateForUnicodeToText(iUnicodeToTextInfo: ConstUnicodeToTextInfo; iSourceLen: ByteCount; iSourceStr: ConstUniCharArrayPtr; iControlFlags: OptionBits; iMaxLen: ByteCount; VAR oTruncatedLen: ByteCount): OSStatus;
  200. { Convert a Pascal string to Unicode string. }
  201. FUNCTION ConvertFromPStringToUnicode(iTextToUnicodeInfo: TextToUnicodeInfo; iPascalStr: ConstStr255Param; iOutputBufLen: ByteCount; VAR oUnicodeLen: ByteCount; oUnicodeStr: UniCharArrayPtr): OSStatus;
  202. { Convert a Unicode string to Pascal string. }
  203. FUNCTION ConvertFromUnicodeToPString(iUnicodeToTextInfo: UnicodeToTextInfo; iUnicodeLen: ByteCount; iUnicodeStr: ConstUniCharArrayPtr; VAR oPascalStr: Str255): OSStatus;
  204. { Count the available conversion mappings. }
  205. FUNCTION CountUnicodeMappings(iFilter: OptionBits; iFindMapping: ConstUnicodeMappingPtr; VAR oActualCount: ItemCount): OSStatus;
  206. { Get a list of the available conversion mappings. }
  207. FUNCTION QueryUnicodeMappings(iFilter: OptionBits; iFindMapping: ConstUnicodeMappingPtr; iMaxCount: ItemCount; VAR oActualCount: ItemCount; VAR oReturnedMappings: UnicodeMapping): OSStatus;
  208. { Setup the fallback handler for converting Unicode To Text. }
  209. FUNCTION SetFallbackUnicodeToText(iUnicodeToTextInfo: UnicodeToTextInfo; iFallback: UnicodeToTextFallbackUPP; iControlFlags: OptionBits; iInfoPtr: LogicalAddress): OSStatus;
  210. { Setup the fallback handler for converting Unicode To TextRuns. }
  211. FUNCTION SetFallbackUnicodeToTextRun(iUnicodeToTextRunInfo: UnicodeToTextRunInfo; iFallback: UnicodeToTextFallbackUPP; iControlFlags: OptionBits; iInfoPtr: LogicalAddress): OSStatus;
  212.  
  213. {$ALIGN RESET}
  214. {$POP}
  215.  
  216. {$SETC UsingIncludes := UnicodeIncludes}
  217.  
  218. {$ENDC} {__UNICODE__}
  219.  
  220. {$IFC NOT UsingIncludes}
  221.  END.
  222. {$ENDC}
  223.